home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / ifl / TIFFGetField.z / TIFFGetField
Encoding:
Text File  |  1998-10-20  |  11.1 KB  |  197 lines
  1.  
  2.  
  3.  
  4. TTTTIIIIFFFFFFFFGGGGeeeettttFFFFiiiieeeelllldddd((((3333TTTT))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   TTTTIIIIFFFFFFFFGGGGeeeettttFFFFiiiieeeelllldddd((((3333TTTT))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      TIFFGetField, TIFFVGetField - get the value(s) of a tag in an open TIFF
  10.      file
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ttttiiiiffffffffiiiioooo....hhhh>>>>
  14.      iiiinnnntttt TTTTIIIIFFFFFFFFGGGGeeeettttFFFFiiiieeeelllldddd((((TTTTIIIIFFFFFFFF**** ttttiiiiffff,,,, ttttttttaaaagggg____tttt ttttaaaagggg,,,, ............))))
  15.      ####iiiinnnncccclllluuuuddddeeee <<<<ssssttttddddaaaarrrrgggg....hhhh>>>>
  16.      iiiinnnntttt TTTTIIIIFFFFFFFFVVVVGGGGeeeettttFFFFiiiieeeelllldddd((((TTTTIIIIFFFFFFFF**** ttttiiiiffff,,,, ttttttttaaaagggg____tttt ttttaaaagggg,,,, vvvvaaaa____lllliiiisssstttt aaaapppp))))
  17.      iiiinnnntttt TTTTIIIIFFFFFFFFGGGGeeeettttFFFFiiiieeeellllddddDDDDeeeeffffaaaauuuulllltttteeeedddd((((TTTTIIIIFFFFFFFF**** ttttiiiiffff,,,, ttttttttaaaagggg____tttt ttttaaaagggg,,,, ............))))
  18.      iiiinnnntttt TTTTIIIIFFFFFFFFVVVVGGGGeeeettttFFFFiiiieeeellllddddDDDDeeeeffffaaaauuuulllltttteeeedddd((((TTTTIIIIFFFFFFFF**** ttttiiiiffff,,,, ttttttttaaaagggg____tttt ttttaaaagggg,,,, vvvvaaaa____lllliiiisssstttt aaaapppp))))
  19.  
  20. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.      _T_I_F_F_G_e_t_F_i_e_l_d returns the value of a tag or pseudo-tag associated with the
  22.      the current directory of the open TIFF file _t_i_f.  (A _p_s_e_u_d_o-_t_a_g is a
  23.      parameter that is used to control the operation of the TIFF library but
  24.      whose value is not read or written to the underlying file.)  The file
  25.      must have been previously opened with _T_I_F_F_O_p_e_n(3T).  The tag is
  26.      identified by _t_a_g, one of the values defined in the include file ttttiiiiffffffff....hhhh
  27.      (see also the table below).  The type and number of values returned is
  28.      dependent on the tag being requested.  The programming interface uses a
  29.      variable argument list as prescribed by the _s_t_d_a_r_g(3) interface.  The
  30.      returned values should only be interpreted if _T_I_F_F_G_e_t_F_i_e_l_d returns 1.
  31.  
  32.      _T_I_F_F_V_G_e_t_F_i_e_l_d is functionally equivalent to _T_I_F_F_G_e_t_F_i_e_l_d except that it
  33.      takes a pointer to a variable argument list.  _T_I_F_F_V_G_e_t_F_i_e_l_d is useful for
  34.      layering interfaces on top of the functionality provided by _T_I_F_F_G_e_t_F_i_e_l_d.
  35.  
  36.      _T_I_F_F_G_e_t_F_i_e_l_d_D_e_f_a_u_l_t_e_d and _T_I_F_F_V_G_e_t_F_i_e_l_d_D_e_f_a_u_l_t_e_d are identical to
  37.      _T_I_F_F_G_e_t_F_i_e_l_d and _T_I_F_F_V_G_e_t_F_i_e_l_d, except that if a tag is not defined in
  38.      the current directory and it has a default value, then the default value
  39.      is returned.
  40.  
  41.      The tags understood by _l_i_b_t_i_f_f, the number of parameter values, and the
  42.      types for the returned values are shown below.  The data types are
  43.      specified as in C and correspond to the types used to specify tag values
  44.      to _T_I_F_F_S_e_t_F_i_e_l_d(3T).  Remember that _T_I_F_F_G_e_t_F_i_e_l_d returns parameter
  45.      values, so all the listed data types are pointers to storage where values
  46.      should be returned.  Consult the TIFF specification for information on
  47.      the meaning of each tag and their possible values.
  48.  
  49.      _T_a_g _N_a_m_e                        _C_o_u_n_t  _T_y_p_e_s             _N_o_t_e_s
  50.      TIFFTAG_ARTIST                  1      char**
  51.      TIFFTAG_BADFAXLINES             1      uint32*
  52.      TIFFTAG_BITSPERSAMPLE           1      uint16*
  53.      TIFFTAG_CLEANFAXDATA            1      uint16*
  54.      TIFFTAG_COLORMAP                3      uint16**          1<<BitsPerSample arrays
  55.      TIFFTAG_COMPRESSION             1      uint16*
  56.      TIFFTAG_CONSECUTIVEBADFAXLINES  1      uint32*
  57.      TIFFTAG_DATATYPE                1      uint16*
  58.      TIFFTAG_DATETIME                1      char**
  59.  
  60.  
  61.                                                                         PPPPaaaaggggeeee 1111
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68. TTTTIIIIFFFFFFFFGGGGeeeettttFFFFiiiieeeelllldddd((((3333TTTT))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   TTTTIIIIFFFFFFFFGGGGeeeettttFFFFiiiieeeelllldddd((((3333TTTT))))
  69.  
  70.  
  71.  
  72.      TIFFTAG_DOCUMENTNAME            1      char**
  73.      TIFFTAG_DOTRANGE                2      uint16*
  74.      TIFFTAG_EXTRASAMPLES            2      uint16*,uint16**  count & types array
  75.      TIFFTAG_FAXMODE                 1      int*              G3/G4 compression pseudo-tag
  76.      TIFFTAG_FAXFILLFUNC             1      TIFFFaxFillFunc*  G3/G4 compression pseudo-tag
  77.      TIFFTAG_FILLORDER               1      uint16*
  78.      TIFFTAG_GROUP3OPTIONS           1      uint32*
  79.      TIFFTAG_GROUP4OPTIONS           1      uint32*
  80.      TIFFTAG_HALFTONEHINTS           2      uint16*
  81.      TIFFTAG_HOSTCOMPUTER            1      char**
  82.      TIFFTAG_IMAGEDEPTH              1      uint32*
  83.      TIFFTAG_IMAGEDESCRIPTION        1      char**
  84.      TIFFTAG_IMAGELENGTH             1      uint32*
  85.      TIFFTAG_IMAGEWIDTH              1      uint32*
  86.      TIFFTAG_INKNAMES                1      char**
  87.      TIFFTAG_INKSET                  1      uint16*
  88.      TIFFTAG_JPEGTABLES              2      u_short*,void**   count & tables
  89.      TIFFTAG_JPEGQUALITY             1      int*              JPEG pseudo-tag
  90.      TIFFTAG_JPEGCOLORMODE           1      int*              JPEG pseudo-tag
  91.      TIFFTAG_JPEGTABLESMODE          1      int*              JPEG pseudo-tag
  92.      TIFFTAG_MAKE                    1      char**
  93.      TIFFTAG_MATTEING                1      uint16*
  94.      TIFFTAG_MAXSAMPLEVALUE          1      uint16*
  95.      TIFFTAG_MINSAMPLEVALUE          1      uint16*
  96.      TIFFTAG_MODEL                   1      char**
  97.      TIFFTAG_ORIENTATION             1      uint16*
  98.      TIFFTAG_PAGENAME                1      char**
  99.      TIFFTAG_PAGENUMBER              2      uint16*
  100.      TIFFTAG_PHOTOMETRIC             1      uint16*
  101.      TIFFTAG_PLANARCONFIG            1      uint16*
  102.      TIFFTAG_PREDICTOR               1      uint16*
  103.      TIFFTAG_PRIMARYCHROMATICITIES   1      float**           6-entry array
  104.      TIFFTAG_REFERENCEBLACKWHITE     1      float**           2*SamplesPerPixel array
  105.      TIFFTAG_RESOLUTIONUNIT          1      uint16*
  106.      TIFFTAG_ROWSPERSTRIP            1      uint32*
  107.      TIFFTAG_SAMPLEFORMAT            1      uint16*
  108.      TIFFTAG_SAMPLESPERPIXEL         1      uint16*
  109.      TIFFTAG_SMAXSAMPLEVALUE         1      double*
  110.      TIFFTAG_SMINSAMPLEVALUE         1      double*
  111.      TIFFTAG_SOFTWARE                1      char**
  112.      TIFFTAG_STRIPBYTECOUNTS         1      uint32**
  113.      TIFFTAG_STRIPOFFSETS            1      uint32**
  114.      TIFFTAG_SUBFILETYPE             1      uint32*
  115.      TIFFTAG_SUBIFD                  2      uint16*,uint32**  count & offsets array
  116.      TIFFTAG_TARGETPRINTER           1      char**
  117.      TIFFTAG_THRESHHOLDING           1      uint16*
  118.      TIFFTAG_TILEBYTECOUNTS          1      uint32**
  119.      TIFFTAG_TILEDEPTH               1      uint32*
  120.      TIFFTAG_TILELENGTH              1      uint32*
  121.      TIFFTAG_TILEOFFSETS             1      uint32**
  122.      TIFFTAG_TILEWIDTH               1      uint32*
  123.      TIFFTAG_TRANSFERFUNCTION        1 or 3|-                  uint16**1<<BitsPerSample entry arrays
  124.  
  125.  
  126.  
  127.                                                                         PPPPaaaaggggeeee 2222
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134. TTTTIIIIFFFFFFFFGGGGeeeettttFFFFiiiieeeelllldddd((((3333TTTT))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   TTTTIIIIFFFFFFFFGGGGeeeettttFFFFiiiieeeelllldddd((((3333TTTT))))
  135.  
  136.  
  137.  
  138.      TIFFTAG_WHITEPOINT              1      float**           2-entry array
  139.      TIFFTAG_XPOSITION               1      float*
  140.      TIFFTAG_XRESOLUTION             1      float*
  141.      TIFFTAG_YCBCRCOEFFICIENTS       1      float**           3-entry array
  142.      TIFFTAG_YCBCRPOSITIONING        1      uint16*
  143.      TIFFTAG_YCBCRSUBSAMPLING        2      uint16*
  144.      TIFFTAG_YPOSITION               1      float*
  145.      TIFFTAG_YRESOLUTION             1      float*
  146.      TIFFTAG_ICCPROFILE              2      uint32*,void**    count, profile data|=
  147.      |- If _S_a_m_p_l_e_s_P_e_r_P_i_x_e_l is one, then a single array is returned; otherwise
  148.      three arrays are returned.
  149.      |= The contents of this field are quite complex.  See _T_h_e _I_C_C _P_r_o_f_i_l_e
  150.      _F_o_r_m_a_t _S_p_e_c_i_f_i_c_a_t_i_o_n, Annex B.3 "Embedding ICC Profiles in TIFF Files"
  151.      (available at http://www.color.org) for an explanation.
  152.  
  153. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  154.      1 is returned if the tag is defined in the current directory; otherwise a
  155.      0 is returned.
  156.  
  157. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  158.      All error messages are directed to the _T_I_F_F_E_r_r_o_r(3T) routine.
  159.  
  160.      UUUUnnnnkkkknnnnoooowwwwnnnn ffffiiiieeeelllldddd,,,, ttttaaaagggg 0000xxxx%%%%xxxx.  An unknown tag was supplied.
  161.  
  162. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  163.      _l_i_b_t_i_f_f(3T), _T_I_F_F_O_p_e_n(3T), _T_I_F_F_S_e_t_F_i_e_l_d(3T), _T_I_F_F_S_e_t_D_i_r_e_c_t_o_r_y(3T),
  164.      _T_I_F_F_R_e_a_d_D_i_r_e_c_t_o_r_y(3T), _T_I_F_F_W_r_i_t_e_D_i_r_e_c_t_o_r_y(3T)
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.                                                                         PPPPaaaaggggeeee 3333
  194.  
  195.  
  196.  
  197.